Add docs sub-commands #4881
Merged
Add docs sub-commands #4881
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sriram-mv
reviewed
Mar 17, 2023
samcli/commands/docs/command.py
Outdated
| self.command_string = self.docs_command.sub_command_string | ||
| self.command_callback = self.docs_command.command_callback | ||
|
|
||
| def get_command(self, ctx: Context, cmd_name: str) -> Command: |
There was a problem hiding this comment.
how does --help text look like?
There was a problem hiding this comment.
I used the new formatters to format the help text. Looks like this for the base command and all sub-commands.
…into docs-sub-commands
…into docs-sub-commands
mildaniel
commented
Mar 21, 2023
| @@ -0,0 +1,21 @@ | |||
| { | |||
| "config": "https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-config.html", | |||
There was a problem hiding this comment.
There are a lot of repetitive URLs here but I left it this way since we have no way of guaranteeing that new URLs will have the same pattern. It also just keeps the configuration easy instead of trying to parse patterns for different types of URLs in our documentation.
lucashuy
reviewed
Mar 21, 2023
moelasmar
reviewed
Mar 23, 2023
moelasmar
reviewed
Mar 23, 2023
moelasmar
reviewed
Mar 23, 2023
moelasmar
reviewed
Mar 23, 2023
moelasmar
approved these changes
Mar 23, 2023
lucashuy
approved these changes
Mar 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue(s) does this change fix?
N/A
Why is this change necessary?
Makes the
sam docscommand more useful by providing invokable sub-commands to open more specific pages.For example, the documentation for each command and its sub-commands is now retrievable with:
and even non-commands like
sam docs config.What side effects does this change have?
N/A
Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpassesmake update-reproducible-reqsif dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.